Skip to content

Commit

Permalink
Update adding-an-api-specification.md
Browse files Browse the repository at this point in the history
Add note to section 'Architectural styles'.
  • Loading branch information
avanbremen committed Jul 3, 2024
1 parent cc2b5a7 commit 8693983
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/learn/adding-an-api-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,16 @@ meaningful and consistent, allowing for a fair comparison between APIs that shar
will apply to the API specification and all of its versions.

When you publish a declaration of conformity, you must use the set of requirements specific to the architectural style
you selected when adding the API specification. We provide code snippets in JSON format to assist you in creating a
declaration. These examples can be easily copied and used with our [Postman Collection](
https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }.
you selected when adding the API specification.

!!! note

If an expected requirement is missing, the ZorgAPIs API server will return an error. If an extra requirement is
provided that is not part of the expected set, the API server will ignore it.

We provide code snippets in JSON format to assist you in creating a declaration. These examples can be easily copied and
used with our
[Postman Collection](https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }.

??? example "Expand to show snippets"

Expand Down

0 comments on commit 8693983

Please sign in to comment.