Correcting URLs, Conforming to Specification, Adding Order, and Minor Corrections

alps-io / imports

Collection of imported vocabularies from other sources (e.g. IANA, Schema.org, microformats, etc.) converted into ALPS documents.

https://alps-io.github.io/imports/

7 stars 2 forks source link

Correcting URLs, Conforming to Specification, Adding Order, and Minor Corrections #3

Closed dillonredding closed 4 years ago

dillonredding commented 4 years ago

Including .xml in hrefs to correct URLs
Removing rt from semantic descriptors to conform to section 2.2.11 of the specification
Adding Order schema and immediate "family" (e.g., OrderStatus, Invoice, ParcelDelivery)
Correcting some typos and updating some existing properties

mamund commented 4 years ago

@dillonredding

do you need me to approve this PR on the alps org?

dillonredding commented 4 years ago

@mamund

No idea 😅 I was going through the ALPS registry and noticed some discrepancies, so I thought I'd contribute some fixes. I didn't see any contribution guidelines, so I decided to just make a PR and go from there. Not sure if these changes will automatically get picked up by the registry or not.

mamund commented 4 years ago

first, really appreciate the contribution. this was a set of scripts/docs that @leonardr put together when we were first working on ALPS and the "RESTful Web APIs" book.

your addtions/fixes are onpoint and i'll be sure to merge them in ASAP.

thanks.

BTW - @filip26 has put together a really nice alps validation/converter that i've been using regularly, too. (https://github.com/filip26/alps)

dillonredding commented 4 years ago

Thank you, @mamund! I might have some more contributions soon 😁

P.S. RESTful Web APIs is basically my bible when it comes to APIs. At work, I lead the team that governs and manages APIs. That book opened my eyes to what is truly REST. It's my baseline, my litmus test for how APIs should be designed and that's the direction I've been pushing for at my job. For that, I thank you!

mamund commented 4 years ago

thanks for the feedback. the book is really @leonardr 's work. i assisted.

and, please keep the contribs coming!

FWIW, originally, we planned for all the href's to be void of media type hints (.xml, .json, etc.) and wanted folks to use conneg to ask for a format they desired. but we never got that up and running. so, thanks for making these all workable. I'll be updating the live site w/ your changes sometime this week.

then i'll work on converting this set to JSON and posting them, too.

thanks again.