Skip to content

Commit

Permalink
add schema
Browse files Browse the repository at this point in the history
  • Loading branch information
apireview committed Aug 2, 2024
1 parent 3207025 commit f87911a
Show file tree
Hide file tree
Showing 69 changed files with 1,021 additions and 729 deletions.
10 changes: 9 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@ search_local: true
collections:
common:
output: true
permalink: /common/:path/
permalink: /common/:path/
schema:
output: true
permalink: /schema/:path/

defaults:

Expand All @@ -43,3 +46,8 @@ defaults:
type: common
values:
layout: common
- scope:
path: ""
type: schema
values:
layout: schema
5 changes: 4 additions & 1 deletion _layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@
</li>
<li class="nav-item">
<a class="nav-link" href="{{ site.url }}/blog/">Blog</a>
</li>
</li>
<li class="nav-item">
<a class="nav-link" href="{{ site.url }}/schema/">Schema</a>
</li>
<li class="nav-item">
<a class="nav-link" href="{{ site.url }}/properties/">Properties</a>
</li>
Expand Down
12 changes: 12 additions & 0 deletions _layouts/schema.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: default
---
<img src="{{ page.image }}" align="right" width="100">
<h2>{{ page.title }}</h2>
<p>{{ page.description }}</p>
<ul>
{% for tag in page.tags %}
<li>{{ tag }}</li>
{% endfor %}
</ul>
<p align="center"><a href="/schema/"><strong>All Schema</strong></a></p>
8 changes: 8 additions & 0 deletions _schema/aid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: AID
description: A unique identifier for the collection, consisting of [root domain]:[string] (ie. apis.json:spec-example).
image: /images/schema.png
url: #
tags:
- Mandatory
---
8 changes: 8 additions & 0 deletions _schema/apis-aid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs AID
description: A unique identifier for the api, consisting of [root domain]:[string] (ie. apis.json:spec-api).
image: /images/schema.png
url: #
tags:
- Mandatory
---
8 changes: 8 additions & 0 deletions _schema/apis-base-url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Base Url
description: Web URL corresponding to the root URL of the API or primary endpoint.
image: /images/schema.png
url: #
tags:
- Mandatory
---
8 changes: 8 additions & 0 deletions _schema/apis-contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Contact
description: An object to describe a person.
image: /images/schema.png
url: #
tags:
- Tag
---
8 changes: 8 additions & 0 deletions _schema/apis-description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Name
description: Human readable text description of the API.
image: /images/schema.png
url: #
tags:
- Mandatory
---
8 changes: 8 additions & 0 deletions _schema/apis-human-url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Human Url
description: Web URL corresponding to human readable information about the API.
image: /images/schema.png
url: #
tags:
- Mandatory
---
8 changes: 8 additions & 0 deletions _schema/apis-image.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Name
description: URL of an image which can be used as an "icon" for the API if displayed by a search engine.
image: /images/schema.png
url: #
tags:
- Optional
---
8 changes: 8 additions & 0 deletions _schema/apis-name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Name
description: Name of the API.
image: /images/schema.png
url: #
tags:
- Mandatory
---
8 changes: 8 additions & 0 deletions _schema/apis-overlays-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Overlays Type
description: The type of overlay being made available.
image: /images/schema.png
url: #
tags:
- Mandatory
---
8 changes: 8 additions & 0 deletions _schema/apis-overlays-url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Overlays URL
description: The URL for the overlay.
image: /images/schema.png
url: #
tags:
- Mandatory
---
9 changes: 9 additions & 0 deletions _schema/apis-overlays.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: APIs Overlays
description: An optional list of overlays to apply to individual APIs.
image: /images/schema.png
url: #
tags:
- Optional
- Collection
---
8 changes: 8 additions & 0 deletions _schema/apis-properties-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Properties Data
description: The data for the property. * must be url or data.
image: /images/schema.png
url: #
tags:
- Tag
---
8 changes: 8 additions & 0 deletions _schema/apis-properties-media-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Properties Media Type
description: IANA media type representing the property.
image: /images/schema.png
url: #
tags:
- Optional
---
8 changes: 8 additions & 0 deletions _schema/apis-properties-name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Properties Name
description: The display name of the property.
image: /images/schema.png
url: #
tags:
- Optional
---
8 changes: 8 additions & 0 deletions _schema/apis-properties-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Properties Type
description: Different properties of an API, see the list of APIs.json properties for a complete list.
image: /images/schema.png
url: #
tags:
- Mandatory
---
8 changes: 8 additions & 0 deletions _schema/apis-properties-url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Properties URL
description: The URL for the property. * must be url or data.
image: /images/schema.png
url: #
tags:
- Optional
---
9 changes: 9 additions & 0 deletions _schema/apis-properties.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: APIs Properties
description: The human and machine-readable properties of an API.
image: /images/schema.png
url: #
tags:
- Collection
- Option
---
9 changes: 9 additions & 0 deletions _schema/apis-tags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: APIs Tags
description: This is a list of descriptive strings which identify the API.
image: /images/schema.png
url: #
tags:
- Collection
- Optional
---
8 changes: 8 additions & 0 deletions _schema/apis-version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: APIs Version
description: String representing the version number of the API this description refers to.
image: /images/schema.png
url: #
tags:
- Optional
---
9 changes: 9 additions & 0 deletions _schema/apis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: APIs
description: List of APIs identified in the file.
image: /images/schema.png
url: #
tags:
- Optional
- Collection
---
8 changes: 8 additions & 0 deletions _schema/common-media-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Common Media Type
description: IANA media type representing the property.
image: /images/schema.png
url: #
tags:
- Optional
---
8 changes: 8 additions & 0 deletions _schema/common-name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Common Name
description: The display name of the property.
image: /images/schema.png
url: #
tags:
- Optional
---
8 changes: 8 additions & 0 deletions _schema/common-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Common Type
description: Please see reserved keywords below.
image: /images/schema.png
url: #
tags:
- Tag
---
8 changes: 8 additions & 0 deletions _schema/common-url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Common URL
description: The URL for the common property.
image: /images/schema.png
url: #
tags:
- Optional
---
9 changes: 9 additions & 0 deletions _schema/common.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Common
description: A list of common properties for use across all APIs and tools.
image: /images/schema.png
url: #
tags:
- Optional
- Collection
---
9 changes: 9 additions & 0 deletions _schema/created.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Created
description: Date of creation of the file.
image: /images/schema.png
url: #
tags:
- Mandatory
- Date
---
8 changes: 8 additions & 0 deletions _schema/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Description
description: Text human readable description of the collection of APIs.
image: /images/schema.png
url: #
tags:
- Mandatory
---
9 changes: 9 additions & 0 deletions _schema/image.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Image
description: Web URL leading to an image to be used to represent the collection of
APIs defined in this file.
image: /images/schema.png
url: #
tags:
- Optional
---
8 changes: 8 additions & 0 deletions _schema/include-name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Include Name
description: The name of the APIs.json file referenced.
image: /images/schema.png
url: #
tags:
- Mandatory
---
8 changes: 8 additions & 0 deletions _schema/include-url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Include URL
description: The URL of the APIs.json file referenced.
image: /images/schema.png
url: #
tags:
- Mandatory
---
9 changes: 9 additions & 0 deletions _schema/include.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Include
description: Additional APIs.json to include with the index.
image: /images/schema.png
url: #
tags:
- Collection
- Optional
---
9 changes: 9 additions & 0 deletions _schema/maintainers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Maintainers
description: Who is responsible for maintaining an APIs.json.
image: /images/schema.png
url: #
tags:
- Collection
- Mandatory
---
9 changes: 9 additions & 0 deletions _schema/modified.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Modified
description: Date of last modification of the file.
image: /images/schema.png
url: #
tags:
- Mandatory
- Date
---
8 changes: 8 additions & 0 deletions _schema/name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Name
description: Text string of human readable name for the collection of APIs.
image: /images/schema.png
url: #
tags:
- Mandatory
---
Loading

0 comments on commit f87911a

Please sign in to comment.