Skip to content
This repository was archived by the owner on Jun 18, 2024. It is now read-only.

Commit d4624c3

Browse files
committed
Merge pull request #437 from konklone/relative
Removes protocol-relative URLs, fixes a doc bug
2 parents 5f80b70 + e2979bb commit d4624c3

File tree

3 files changed

+15
-16
lines changed

3 files changed

+15
-16
lines changed

Diff for: _config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
#document settings
22
title: Project Open Data
33
desc: "Open Data Policy — Managing Information as an Asset"
4-
url: //project-open-data.cio.gov/
4+
url: https://project-open-data.cio.gov/
55
repo_name: project-open-data.github.io
66
branch: master
77

88
#global settings, no need to change these
9-
root_url: //project-open-data.cio.gov
9+
root_url: https://project-open-data.cio.gov
1010
org_name: project-open-data
1111

1212
# default build settings for running locally, no need to edit

Diff for: _includes/footer.html

+3-4
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@
1313
</div>
1414
</div><!-- /container -->
1515

16-
17-
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
18-
<script>window.jQuery || document.write('<script src="/assets/js/vendor/jquery-1.11.1.min.js"><\/script>')</script>
16+
17+
<script src="/assets/js/vendor/jquery-1.11.1.min.js"></script>
1918
<script src="/assets/js/bootstrap.min.js"></script>
20-
19+
2120

2221

2322
</body>

Diff for: v1.1/api.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,38 @@ permalink: /v1.1/api/
66
filename: api.md
77
---
88

9-
Agencies should list private, internal, and public-facing web APIs as part of their Enterprise Data Inventory and Public Data Listing data.json files. The original v1.0 schema accommodated the listing of APIs with a separate `webServices` field, but with the [v1.1 schema](/v1.1/schema/), APIs should now be listed as a separate distribution within a dataset. Since an API provides indirect access to a dataset and the primary URL that a user needs in order to access the API is the API documentation, all web APIs should be referenced using the primary API documentation URL as an `accessURL` with the `format` specified as "API". The `downloadURL` and `mediaType` fields should be left empty for a distribution that describes an API, but if the raw data download that powers the API is also available (as it should be) then that should be specified using the `downloadURL` and `mediaType` of another distribution entry on the same dataset.
9+
Agencies should list private, internal, and public-facing web APIs as part of their Enterprise Data Inventory and Public Data Listing data.json files. The original v1.0 schema accommodated the listing of APIs with a separate `webServices` field, but with the [v1.1 schema](/v1.1/schema/), APIs should now be listed as a separate distribution within a dataset. Since an API provides indirect access to a dataset and the primary URL that a user needs in order to access the API is the API documentation, all web APIs should be referenced using the primary API documentation URL as an `accessURL` with the `format` specified as "API". The `downloadURL` and `mediaType` fields should be left empty for a distribution that describes an API, but if the raw data download that powers the API is also available (as it should be) then that should be specified using the `downloadURL` and `mediaType` of another distribution entry on the same dataset.
1010

1111
Machine Readable API Documentation
1212
--------------------------------------------------
1313

14-
For APIs that also have machine readable documentation (like [Swagger](https://github.com/swagger-api/swagger-spec#readme), [RAML](http://raml.org/), [API Blueprint](https://apiblueprint.org/), [HAL](http://stateless.co/hal_specification.html), [Hydra](http://www.w3.org/ns/hydra/spec/latest/core/), etc) it can be specified with `describedBy` and `describedByType`. The URL for the machine readable documentation should be specified by `describedBy` and `describedByType` should be a media type that identifies the format of the machine readable documentation.
14+
For APIs that also have machine readable documentation (like [Swagger](https://github.com/swagger-api/swagger-spec#readme), [RAML](http://raml.org/), [API Blueprint](https://apiblueprint.org/), [HAL](http://stateless.co/hal_specification.html), [Hydra](http://www.w3.org/ns/hydra/spec/latest/core/), etc) it can be specified with `describedBy` and `describedByType`. The URL for the machine readable documentation should be specified by `describedBy` and `describedByType` should be a media type that identifies the format of the machine readable documentation.
1515

1616
Media Types for Machine Readable API Documentation
1717
--------------------------------------------------
1818

19-
These media types should be used for the `describedByType` field along with the URL to the machine readable documentation itself using the `describedBy` field. This should not be confused with the `format` field which should be "API" for an API and `mediaType` which should be blank for an API.
19+
These media types should be used for the `describedByType` field along with the URL to the machine readable documentation itself using the `describedBy` field. This should not be confused with the `format` field which should be "API" for an API and `mediaType` which should be blank for an API.
2020

21-
* The media type for Swagger has been [proposed](https://github.com/wordnik/swagger-spec/issues/110) as `application/swagger+json`
21+
* The media type for Swagger has been [proposed](https://github.com/wordnik/swagger-spec/issues/110) as `application/swagger+json`
2222
* The media type for RAML has been [defined](http://raml.org/spec.html#overview) as `application/raml+yaml`
2323
* The media type for API Blueprint has been [defined](https://github.com/apiaryio/api-blueprint-ast#media-types) as `application/vnd.apiblueprint.ast` in abstract syntax tree form, plus others depending on the serialization
2424
* The media type for HAL has been [defined](http://stateless.co/hal_specification.html) as `application/hal+json` and `application/hal+xml` for the JSON and XML variants.
25-
* The media type for Hydra has been [proposed](http://www.w3.org/ns/hydra/spec/latest/core/#h3_adding-affordances-to-representations) as `application/ld+json` with `rel="http://www.w3.org/ns/hydra/core#apiDocumentation"` included in the `Link` HTTP header.
25+
* The media type for Hydra has been [proposed](http://www.w3.org/ns/hydra/spec/latest/core/#h3_adding-affordances-to-representations) as `application/ld+json` with `rel="http://www.w3.org/ns/hydra/core#apiDocumentation"` included in the `Link` HTTP header.
2626

2727
Reference Standardized API Specifications
2828
--------------------------------------------------
29-
Some APIs may implement a common standard such as WMS, WFS, or Open311. If this is an established standard, use the canonical URI for the standard as the value for the `conformsTo` field in the same distribution object where the API is listed.
29+
Some APIs may implement a common standard such as WMS, WFS, or Open311. If this is an established standard, use the canonical URI for the standard as the value for the `conformsTo` field in the same distribution object where the API is listed.
3030

3131
Example of an API listing in a data.json file
3232
--------------------------------------------------
3333
~~~~
3434
"distribution":
3535
{
36-
"accessURL": "http://www.agency.gov/api/vegetables/",
36+
"accessURL": "http://www.agency.gov/api/vegetables/",
3737
"description": "A fully queryable REST API with JSON and XML output",
38-
"describedBy": "http: //www.agency.gov/api/vegetables/swagger.json",
39-
"describedByType": "application/swagger+json",
40-
"format": "API",
38+
"describedBy": "http://www.agency.gov/api/vegetables/swagger.json",
39+
"describedByType": "application/swagger+json",
40+
"format": "API",
4141
"title": "Vegetables REST API"
4242
}
4343
]

0 commit comments

Comments
 (0)