Skip to content

Commit

Permalink
docs(bindings): HTTP docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Pakisan committed May 14, 2024
1 parent 485f4be commit f7c0dfd
Show file tree
Hide file tree
Showing 20 changed files with 68 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
* Describes HTTP channel binding.
*
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#channel-binding-object">HTTP channel binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @since 1.0.0-RC2
*/
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
* Contains information about the message representation in HTTP.
*
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#message-binding-object">HTTP message binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @since 1.0.0-RC2
*/
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
* Contains information about the operation representation in HTTP.
*
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#operation-binding-object">HTTP operation binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @since 1.0.0-RC2
*/
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
* Describes HTTP server binding.
*
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#server-binding-object">HTTP server binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @since 1.0.0-RC2
*/
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@
* <p>
* Describes HTTP channel binding.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#channel-binding-object">HTTP channel binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@NoArgsConstructor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the message representation in HTTP.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#message-binding-object">HTTP message binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@
* <p>
* Contains information about the operation representation in HTTP.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#operation-binding-object">HTTP operation binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
package com.asyncapi.bindings.http.v0._1_0.operation;

/**
* Describes HTTP operation type.
* Describes HTTP operation method type.
* <p>
* Contains information about the operation type.
* Contains information about the operation method.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#operation-binding-object">HTTP operation binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
public enum HTTPOperationMethod {
GET,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

import com.fasterxml.jackson.annotation.JsonProperty;

/**
* Describes HTTP operation type.
* <p>
* Contains information about the operation type.
*
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#operation-binding-object">HTTP operation binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
public enum HTTPOperationType {

@JsonProperty("request")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@
* <p>
* Describes HTTP server binding.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#server-binding-object">HTTP server binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@NoArgsConstructor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@
* <p>
* Describes HTTP channel binding.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#channel-binding-object">HTTP channel binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
@Data
@NoArgsConstructor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the message representation in HTTP.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#message-binding-object">HTTP message binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the operation representation in HTTP.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#operation-binding-object">HTTP operation binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
package com.asyncapi.bindings.http.v0._2_0.operation;

/**
* Describes HTTP operation type.
* Describes HTTP operation method.
* <p>
* Contains information about the operation type.
* Contains information about the operation method.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#operation-binding-object">HTTP operation binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
public enum HTTPOperationMethod {
GET,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@
* <p>
* Describes HTTP server binding.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#server-binding-object">HTTP server binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
@Data
@NoArgsConstructor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@
* <p>
* Describes HTTP channel binding.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#channel-binding-object">HTTP channel binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@Data
@NoArgsConstructor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the message representation in HTTP.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#message-binding-object">HTTP message binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the operation representation in HTTP.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#operation-binding-object">HTTP operation binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@
* <p>
* Contains information about the operation type.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#operation-binding-object">HTTP operation binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
public enum HTTPOperationMethod {
GET,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@
* <p>
* Describes HTTP server binding.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/http#server-binding-object">HTTP server binding</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview">MDN HTTP overview</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@Data
@NoArgsConstructor
Expand Down

0 comments on commit f7c0dfd

Please sign in to comment.