Skip to content

Commit

Permalink
Add navigation sections 'Organizations' and 'APIs'
Browse files Browse the repository at this point in the history
 - Add section index pages
 - Refactor links
 - Update page tree
  • Loading branch information
avanbremen committed Sep 12, 2024
1 parent e17fe85 commit f00fcd4
Show file tree
Hide file tree
Showing 10 changed files with 49 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/blog/posts/adding-an-avatar-to-your-organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ and display the avatar from these profiles, enhancing your organization's brand
https://www.zorgapis.nl/){: target="_blank" } and making it easier for users to identify and engage with your APIs.

We encourage you to update your organization's profile and take advantage of this new functionality. We have updated
our [documentation](../../learn/adding-an-organization.md) to guide you through the process of adding or updating your
organization details.
our [documentation](../../learn/organizations/adding-an-organization.md) to guide you through the process of adding or
updating your organization details.
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ erDiagram
```

1. The name of the API specification, must be **unique** for this organization (see `#!js "organizationId"`).
2. The UUID of the [organization](./adding-an-organization.md#add-organization) that maintains the API
specification.
2. The UUID of the [organization](../organizations/adding-an-organization.md#add-organization) that maintains the
API specification.
3. The architectural style of the API specification, and therefore of all associated versions. For example,
`#!js "REST"` or `#!js "SOAP"`.

Expand Down Expand Up @@ -67,8 +67,8 @@ erDiagram
1. The name of the API specification version, must be **unique** for this API specification.
2. The date and time (formatted as per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601){: target="_blank" }) at
which the API specification version was published. In other words, the date and time at which this version was
first made available by the [organization](./adding-an-organization.md#add-organization) that maintains the API
specification.
first made available by the [organization](../organizations/adding-an-organization.md#add-organization) that
maintains the API specification.

**Note**: `publishTime` is **not** to be used for the date and time at which this version is published in the
API Library for Dutch Healthcare. This value is set automatically by the API server upon creation of the item
Expand Down
File renamed without changes.
13 changes: 13 additions & 0 deletions docs/learn/apis/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# APIs

Learn how to add your API specification and its versions to the [API Library for Dutch Healthcare](
https://www.zorgapis.nl/){: target="_blank" }.

## Resources

<div class="grid cards" markdown>

- :material-clipboard-check: **[API requirements](./getting-api-requirements.md)** – Get API requirements
- :material-api: **[API specifications](./adding-an-api-specification.md)** – Add API specifications and versions

</div>
10 changes: 3 additions & 7 deletions docs/learn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,8 @@ and API specifications, or publishing declarations of conformity.

<div class="grid cards" markdown>

- :material-shield-lock: **[Authorization](./authorizing-a-request.md)** – Authorize a request
- :material-clipboard-check: **[API requirements](./getting-api-requirements.md)** – Get API requirements
- :material-office-building: **[Organizations](./adding-an-organization.md)** – Add organizations
- :material-api: **[API specifications](./adding-an-api-specification.md)** – Add API specifications and versions
- :material-account-plus: **[Invitations](./inviting-a-user-to-an-organization.md)** – Invite users to an organization
- :material-account-check: **[Accept invitations](./accepting-an-invitation-to-join-an-organization.md)** – Accept
pending invitations for an organization
- :material-shield-lock: **[Authorization](./authorizing-a-request.md)** – Register an account
- :material-office-building: **[Organizations](./organizations/adding-an-organization.md)** – Add your organization
- :material-api: **[API specifications](./apis/adding-an-api-specification.md)** – Add your API specification

</div>
File renamed without changes.
16 changes: 16 additions & 0 deletions docs/learn/organizations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Organizations

Learn how to add your organization to the [API Library for Dutch Healthcare](
https://www.zorgapis.nl/){: target="_blank" } and invite users to collaborate on maintaining your organization's profile
and contributions.

## Resources

<div class="grid cards" markdown>

- :material-office-building: **[Organizations](./adding-an-organization.md)** – Add organizations
- :material-account-plus: **[Invitations](./inviting-a-user-to-an-organization.md)** – Invite users to an organization
- :material-account-check: **[Accept invitations](./accepting-an-invitation-to-join-an-organization.md)** – Accept
pending invitations for an organization

</div>
16 changes: 11 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,17 @@ nav:
- Learn:
- learn/index.md
- Authorizing a request: learn/authorizing-a-request.md
- Getting API requirements: learn/getting-api-requirements.md
- Adding an organization: learn/adding-an-organization.md
- Adding an API specification: learn/adding-an-api-specification.md
- Inviting a user to an organization: learn/inviting-a-user-to-an-organization.md
- Accepting an invitation to join an organization: learn/accepting-an-invitation-to-join-an-organization.md
- Organizations:
- learn/organizations/index.md
- Adding an organization: learn/organizations/adding-an-organization.md
- Inviting a user to an organization: learn/organizations/inviting-a-user-to-an-organization.md
- Accepting an invitation to join an organization: learn/organizations/accepting-an-invitation-to-join-an-organization.md
- APIs:
- learn/apis/index.md
- Getting API requirements: learn/apis/getting-api-requirements.md
- Adding an API specification: learn/apis/adding-an-api-specification.md
#- Standards:
#- Agreements:
- Play:
- play/index.md
- Code: code/index.md
Expand Down

0 comments on commit f00fcd4

Please sign in to comment.