Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
inadarei committed Jan 15, 2018
1 parent 7f38d09 commit 03c715b
Show file tree
Hide file tree
Showing 8 changed files with 228 additions and 53 deletions.
18 changes: 18 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8

[Makefile]
indent_style = tab
tab_width = 4

[*.md]
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
max_line_length = 100
55 changes: 3 additions & 52 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,52 +1,3 @@
# Prerequisites
*.d

# Object files
*.o
*.ko
*.obj
*.elf

# Linker output
*.ilk
*.map
*.exp

# Precompiled Headers
*.gch
*.pch

# Libraries
*.lib
*.a
*.la
*.lo

# Shared objects (inc. Windows DLLs)
*.dll
*.so
*.so.*
*.dylib

# Executables
*.exe
*.out
*.app
*.i*86
*.x86_64
*.hex

# Debug files
*.dSYM/
*.su
*.idb
*.pdb

# Kernel Module Compile Results
*.mod*
*.cmd
.tmp_versions/
modules.order
Module.symvers
Mkfile.old
dkms.conf
.DS_Store
.refcache
_site
Empty file added .nojekyll
Empty file.
2 changes: 2 additions & 0 deletions CREDITS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Setup of the environment, as well as makefile etc. based on:
https://github.com/mnot/I-D
57 changes: 57 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@

id_base = ..
xml2rfc ?= xml2rfc
saxpath ?= /usr/local/share/saxon-b/saxon9.jar
kramdown-rfc2629 ?= kramdown-rfc2629
bootstrap ?= ../Tools/rfcbootstrap/rfcbootstrap.xslt
idnits ?= idnits

title = inadarei-$(shell basename ${CURDIR})
latest = $(shell (ls draft-${title}-*.xml || echo "draft-${title}-00.xml") | sort | tail -1)
version = $(shell basename ${latest} .xml | awk -F- '{print $$NF}')

target = draft-$(title)-$(version)
prev = draft-$(title)-$(shell printf "%.2d" `echo ${version}-1 | bc`)
next = draft-$(title)-$(shell printf "%.2d" `echo ${version}+1 | bc`)

.PHONY: latest clean next diff idnits update

latest: $(target).html $(target).txt index.html index.txt

clean:
rm -f $(target).html $(target).txt

next:
cp $(target).xml $(next).xml
sed -i '' -e"s/$(target)/$(next)/" draft.md

diff:
rfcdiff $(prev).txt $(target).txt

idnits: $(target).txt
$(idnits) $<

%.xml: draft.md
$(kramdown-rfc2629) $< > $@

%.html: %.xml
sed -i '' -e"s/\"rfc2629.dtd/\"$(id_base)\/Tools\/rfcbootstrap\/rfc2629.dtd/" $<
java -classpath $(saxpath) net.sf.saxon.Transform -l $< $(bootstrap) \
bootstrapJsUrl='../Tools/bower_components/bootstrap/dist/js/bootstrap.min.js' \
bootstrapCssUrl='../Tools/bower_components/bootstrap/dist/css/bootstrap.min.css' \
jqueryJsUrl='../Tools/bower_components/jquery/dist/jquery.min.js' \
navbar='../Tools/navbar.html' \
> $@
# $(xml2rfc) --html $< $@

%.txt: %.xml
$(xml2rfc) $< $@

index.html: $(target).html
cp $< $@

index.txt: $(target).txt
cp $< $@

update:
cp $(id_base)/Tools/skel/Makefile .
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# rfc-healthcheck
# api-healthcheck

Health Check Endpoint for HTTP APIs
85 changes: 85 additions & 0 deletions draft-inadarei-api-healthcheck-00.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE rfc SYSTEM "http://xml.resource.org/authoring/rfc2629.dtd" [
<!ENTITY rfc2119 SYSTEM 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>
]>

<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<?rfc toc="yes" ?>
<?rfc tocdepth="3" ?>
<?rfc tocindent="yes" ?>
<?rfc symrefs="yes" ?>
<?rfc sortrefs="yes"?>
<?rfc iprnotified="no" ?>
<?rfc strict="yes" ?>
<?rfc compact="yes" ?>
<?rfc comments="yes" ?>
<?rfc inline="yes" ?>

<rfc ipr="trust200902" docName="draft-inadarei-api-healthcheck-00" category="info">

<front>
<title></title>
<author initials="I." surname="Nadareishvili" fullname="Irakli Nadareishvili">
<organization></organization>
<address>
<email>[email protected]</email>
<uri>http://www.freshblurbs.com/</uri>
</address>
</author>
<date year="2018"/>
<abstract>

<t></t>

</abstract>
</front>

<middle>

<section title="Introduction">

</section>

<section title="Requirements">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in
this document are to be interpreted as described in <xref
target="RFC2119"/>.</t>
</section>



<section title="Security Considerations">

<t>TBD</t>

</section>

<section title="IANA Considerations">

<t>TBD</t>

</section>

</middle>

<back>
<references title="Normative References">
&rfc2119;
</references>

<references title="Informative References">

</references>

<section title="Acknowledgements">
<t>Thanks to

for their suggestions and feedback.
</t>
<t>The author takes all responsibility for errors and
omissions.</t>
</section>
</back>
</rfc>
61 changes: 61 additions & 0 deletions draft.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title:
abbrev:
docname: draft-inadarei-api-healthcheck-00
date: 2017
category: info

ipr: trust200902
area: General
workgroup:
keyword: Internet-Draft

stand_alone: yes
pi: [toc, tocindent, sortrefs, symrefs, strict, compact, comments, inline]

author:
-
ins: I. Nadareishvili
name: Irakli Nadareishvili
organization:
email: [email protected]
uri: http://www.freshblurbs.com/

normative:
RFC2119:

informative:


--- abstract


--- note_Note_to_Readers

*RFC EDITOR: please remove this section before publication*

The issues list for this draft can be found at <https://github.com/mnot/I-D/labels/api-healthcheck>.

The most recent (often, unpublished) draft is at <https://mnot.github.io/I-D/api-healthcheck/>.

Recent changes are listed at <https://github.com/mnot/I-D/commits/gh-pages/api-healthcheck>.

See also the draft's current status in the IETF datatracker, at
<https://datatracker.ietf.org/doc/draft-inadarei-api-healthcheck/>.

--- middle

# Introduction

## Notational Conventions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",
"RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as
described in BCP 14 {{!RFC2119}} {{!RFC8174}} when, and only when, they appear in all capitals, as
shown here.


# Security Considerations


--- back

0 comments on commit 03c715b

Please sign in to comment.