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

Iinitial set of annotations describing raml 2 java mapping #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

petrochenko-pavel-a
Copy link

No description provided.

@@ -0,0 +1,100 @@
#%RAML 1.0 Library
uses:
commons: "https://raw.githubusercontent.com/apiregistry/commons/master/commons.raml"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we include the commons RAML in here as well, or what is that exactly. I would argue to minimize the amount of external dependencies.

@sichvoge
Copy link
Contributor

Hi Pavel, thanks! Looking at your PR, shall we create a specific folder called "sdks" or "sdk-generation" so that we can group them inside this repo? Also, it would be good to have a markdown file attached that explains the usage a bit and also where it can be used so far like in a table.

I would also bring in your common annotations if necessary; but not sure if we should bring in information about the author etc inside the fragment file or inside the attached markdown.

types:
JavaPackage: string
TypeName: string
(commons.Authors):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure about that to be honest. Its kinda additional information that you might want to have for building a separate registry, but there might be better options than putting it into the fragment file. Again, if its not import for the consumer (in this case the application that reads those annotations), I would try to bring in the meta information in a different form.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants